Device Log Export Tool

The Device Log Export tool allows an Administrator to export a job log to a CSV format file in a specified folder. The command line tool must be run on the Delegation Server that manages the device from which you want to export the log. In cases where you have more than one Delegation Server, you can install the Device Log Export tool on each Delegation Server.

These instructions explain how to export a job log from the Command prompt.

  1. Open a command prompt and navigate to the installation path of RICOH Streamline NX (by default the path where the tool is located is c:\Program Files\Ricoh\ RICOH Streamline NX \tools\DeviceLogExportingTool, but the full path may be different in your installation).

  2. Optionally, configure the following parameters in the file ‘\DeviceLogExportingTool\config.properties’ prior to running the .bat file in the step below.

    These options allow you to specify the output settings that will be applied when a job log is exported.

    Parameter

    Default Value

    		 Description
    output.folder " "

    Folder path for output of the job log.

    Specify the folder path for outputting the job log.

    If this parameter is empty, it outputs to the directory that stored the .bat file.
    output.filename " "

    File name for output of the job log.

    Specify the file name for output the job log. If you do not set this parameter, it saves as the following name: deviceJobLog-[start date][end date].csv

    If the specified file already exists, the new file will overwrite the existing file.
    output.encode UTF-8

    File encoding for the output job log.

    Options are either UTF-8 or Shiftjis:

    • UTF-8: Output the encoding of the csv file is UTF-8.

    • Shiftjis: Output the encoding of the csv file encode is Shift-JIS.

    devicelog.timetype

    GMT

    Specify the time zone as either GMT or LocalTime:

    • GMT: Output the date as GMT (Greenwich mean time). The date format is YYYY-MM-DDThh:mm:ssZ when "GMT" is selected.

    • LocalTime: Output the date as Local time of the server. The date format is YYYY-MM-DDThh:mm:ss as local time of the server when "LocalTime" is selected.

    • Time conversion information (i.e. GMT+540) is recorded in the third line of the exported .csv file.

    devicelog.isRegistDate

    true

    Target the registDate of the output job log:

    • false: To determine the scope of output in the occurrence date (occurrenceDate) of Device Log.

    • true: To determine the scope of output in the registration date (registDate) of Device Log.

  3. Optionally, configure the following parameters in the file ‘\DeviceLogExportingTool\result.properties’ prior to running the .bat file in the step below.

    When the application runs for the first time, it records the date of execution to ‘result.properties’. The next time you run the application, it will use the last recorded date of execution to output the job log for the period between the last recorded executed date and the date prior to the current date (yesterday).

    If the devicelog.lastExecutedDate parameter is empty (as it will be the first time you run the application), the job log will contain data from the oldest possible information available to the date prior to the current date (yesterday).

    Parameter

    Default Value

    		 Description
    devicelog.lastExecutedDate " " Last executed date is updated each time you run the application. You can edit this parameter manually as needed.

  4. Run the command ‘DeviceLogExportingTool.bat’.

    To schedule this task using Windows Scheduler, refer to the technical information provided by Microsoft at https://technet.microsoft.com/library/Cc748993.aspx.

    The job log will be export as per the settings in the config. Properties file. The devicelog.timetype and devicelog.isRegistDate parameters determine the output in the following columns:

    general#registDate

    source_pdl#pdlStartTime_c

    general#occurrenceDate

    source_pdl#pdlEndTime

    general#entryDate

    source_pdl#pdlEndTime_c

    general#entryDate_c

    destination_memory#desMemStartTime

    general#finishDate

    destination_memory#desMemStartTime_c

    general#finishDate_c

    destination_memory#desMemEndTime

    source_scan#scanStartTime

    destination_memory#desMemEndTime_c

    source_scan#scanStartTime_c

    destination_network#desNetStartTime

    source_scan#scanEndTime

    destination_network#desNetStartTime_c

    source_scan#scanEndTime_c

    destination_network#desNetEndTime

    source_network#srcNetStartTime

    destination_plot#plotStartTime

    source_network#srcNetStartTime_c

    destination_plot#plotStartTime_c

    source_network#srcNetEndTime

    destination_plot#plotEndTime

    source_network#srcNetEndTime_c

    destination_plot#plotEndTime_c

    source_pdl#pdlStartTime